/*
   Bacula(R) - The Network Backup Solution

   Copyright (C) 2000-2025 Kern Sibbald

   The original author of Bacula is Kern Sibbald, with contributions
   from many others, a complete list can be found in the file AUTHORS.

   You may use this file and others of this release according to the
   license defined in the LICENSE file, which includes the Affero General
   Public License, v3.0 ("AGPLv3") and some additional permissions and
   terms pursuant to its AGPLv3 Section 7.

   This notice must be preserved when any source code is
   conveyed and/or propagated.

   Bacula(R) is a registered trademark of Kern Sibbald.
*/
/*
 *
 *   Bootstrap Record header file
 *
 *      BSR (bootstrap record) handling routines split from
 *        ua_restore.c July MMIII
 *
 *     Kern Sibbald, July MMII
 *
 */

#ifndef BSR_H
#define BSR_H

/* FileIndex entry in restore bootstrap record */
struct RBSR_FINDEX {
   rblink  link;
   int32_t findex;
   int32_t findex2;
};

/*
 * Restore bootstrap record -- not the real one, but useful here
 *  The restore bsr is a chain of BSR records (linked by next).
 *  Each BSR represents a single JobId, and within it, it
 *    contains a linked list of file indexes for that JobId.
 *    The complete_bsr() routine, will then add all the volumes
 *    on which the Job is stored to the BSR.
 */
struct RBSR {
   rblink link;
   JobId_t JobId;                     /* JobId this bsr */
   uint32_t VolSessionId;
   uint32_t VolSessionTime;
   int      VolCount;                 /* Volume parameter count */
   VOL_PARAMS *VolParams;             /* Volume, start/end file/blocks */
   rblist *fi_list;                   /* File indexes this JobId */
   char   *fileregex;                 /* Only restore files matching regex */

   /* If we extend an existing fi, keep the memory for the next insert */
   RBSR_FINDEX *m_fi;
};


class UAContext;
/* Structure used to quickly scan the BSR file and find
 * the right storage daemon to connect to
 */
struct bootstrap_info
{
   FILE *bs;
   UAContext *ua;
   char storage[MAX_NAME_LENGTH+1];
   alist *split_list; /* when a BSR cannot be restored in once, this is a list */
                      /* of offset where to split the BSR to send to the SD */
   boffset_t *next_split_off; /* the next split position */
};
bool open_bootstrap_file(JCR *jcr, bootstrap_info &info);
void close_bootstrap_file(bootstrap_info &info);

#endif
